home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2004 #2 / Amiga Plus CD - 2004 - No. 02.iso / AmigaPlus / Games / ScummVM_68k / README < prev    next >
Encoding:
Text File  |  2004-01-31  |  40.0 KB  |  929 lines

  1. ScummVM README
  2. Last updated:    2003-08-06
  3. Release version: 0.5.1
  4. ------------------------------------------------------------------------
  5.  
  6. For more information, compatibility lists, details on donating, the latest
  7. release, progress reports and more, please visit the ScummVM home page
  8. at: http://www.scummvm.org/
  9.  
  10. Table of Contents:
  11. ------------------
  12. 1.0) About
  13. 2.0) Contacting
  14.  * 2.1 Reporting Bugs
  15. 3.0) Supported Games
  16.  * 3.1 Copy Protection
  17.  * 3.2 Simon the Sorcerer notes
  18.  * 3.3 Known Bugs
  19. 4.0) Supported Platforms
  20. 5.0) Running ScummVM
  21.  * 5.1 Command Line Options
  22.  * 5.2 Language Options
  23.  * 5.3 Graphics Filters
  24.  * 5.4 Hotkeys
  25.  * 5.5 Using Macintosh games
  26. 6.0) Savegames
  27.  * 6.1 Autosaves
  28. 7.0) Music and Sound
  29.  * 7.1 Adlib emulation
  30.  * 7.2 MIDI emulation
  31.  * 7.3 Native MIDI support
  32.  * 7.4 UNIX native & ALSA sequencer support
  33.  * 7.5 Using MP3 or OGG to store/compress audio
  34. 8.0) Configuration Files
  35. 9.0) Compiling
  36. X.X) Credits
  37.  
  38. 1.0) About:
  39. ---- ------ 
  40. ScummVM is a collection of interpreters, capable of emulating several
  41. adventure game engines. ScummVM mainly supports engines created using 
  42. SCUMM (Script Creation Utility for Maniac Mansion), used in various
  43. LucasArts games such as Monkey Island, Day of the Tentacle, and others.
  44. ScummVM also contains interpreters for several non-SCUMM games, currently
  45. these are Simon the Sorcerer (1 & 2), and Beneath a Steel Sky.
  46.  
  47. At this time ScummVM should be considered beta software, and is still
  48. under heavy development. Be aware that whilst we attempt to make sure
  49. that many games can be completed with few major bugs, crashes can happen. 
  50.  
  51. If you enjoy ScummVM feel free to donate using the PayPal button on the
  52. ScummVM homepage. This will help us buy utilities needed to develop ScummVM
  53. easier and quicker. If you cannot donate, help and contribute a patch!
  54.  
  55. 2.0) Contacting:
  56. ---- ----------
  57. The easiest way to contact the ScummVM team is by submitting bug reports or
  58. commenting in our forums. You can also join and e-mail the scummvm-devel
  59. mailing list, or chat with us on irc (#scummvm on irc.freenode.net)
  60. Please do not ask us to support an unsupported game - read our homepages
  61. FAQ first.
  62.  
  63. 2.1) Reporting Bugs:
  64. ---- ---------------
  65. To report a bug, please create a SourceForge account and follow the bugs
  66. link from our homepage. Please make sure the bug is reproducible, and
  67. still occurs in the latest daily build/current CVS version. Also check
  68. the known bugs list (below) and compatibility listing for that game, to
  69. ensure the issue is not already known.
  70.  
  71. Also do not report bugs on games that are not listed as being completable
  72. in the 'Supported Games' section, or compatibility list. We -know- those
  73. games have bugs.
  74.  
  75. Please include the following information:
  76.         - ScummVM version (PLEASE test the latest CVS/Daily build)
  77.         - Bug details, including instructions on reproducing
  78.         - Language of game (English, German, ...)
  79.         - Version of game (talkie, floppy, ...)
  80.         - Platform and Compiler (Win32, Linux, FreeBSD, ...)
  81.         - Attach a save game if possible
  82.         - If this bug only occurred recently, please note the last
  83.           version without the bug, and the first version including
  84.           the bug. That way we can fix it quicker by looking at the
  85.           changes made.
  86.  
  87. 3.0) Supported Games:
  88. ---- ----------------
  89. At the moment the following games have been reported to work, and should
  90. be playable to the end. However, this list generally applies to PC versions.
  91. Mac versions should work after being "ReSCUMM'ed" (see later in this document),
  92. and Amiga versions of games may work with the 'Amiga' flag turned on - but
  93. this is not always true.
  94.  
  95. SCUMM Games:
  96.      Maniac Mansion (Enhanced Version)               [Game: maniac]
  97.      Zak McKracken (Enhanced Version)                [Game: zak]
  98.      Indiana Jones & the Last Crusade (EGA)          [Game: indy3ega]
  99.      Indiana Jones & the Last Crusade (256)          [Game: indy3]
  100.      Indiana Jones & the Last Crusade (256 FM Towns) [Game: indy3towns]
  101.      Loom (16 color floppy version)                  [Game: loom]
  102.      Loom (256 color CD version)                     [Game: loomcd]
  103.      Zak McKracken (256 FM Towns)                    [Game: zak256]
  104.      Monkey Island 1 (EGA version)                   [Game: monkeyega]
  105.      Monkey Island 1 (VGA version)                   [Game: monkeyvga]
  106.      Monkey Island 1 (CD version)                    [Game: monkey/monkey1]
  107.      Monkey Island 2                                 [Game: monkey2]
  108.      Indiana Jones and the Fate of Atlantis          [Game: atlantis]
  109.      Day of the Tentacle                             [Game: tentacle]
  110.      Sam & Max                                       [Game: samnmax]
  111.      The Dig                                         [Game: dig]
  112.      Curse of Monkey Island                          [Game: comi]
  113.  
  114. Other Games:
  115.      Beneath a Steel Sky                             [Game: sky]
  116.      Simon the Sorcerer 1                            [Game: simon1dos/
  117.                                                             simon1talkie/
  118.                                                             simon1win]
  119.      Simon the Sorcerer 2                            [Game: simon2dos/
  120.                                                             simon2talkie/
  121.                                                             simon2win
  122.                                                             simon2mac]
  123.  
  124. The following games should be completable, but have some critical problems that
  125. prevent them from being fully supported at this time. Please do not file bug
  126. reports about them.
  127.         
  128.      Full Throttle                                 [Game: ft]
  129.      Zak McKracken (256 color, Towns Kanji ver)    [Game: zak256]
  130.  
  131. The following games should load, but are not yet fully playable. Play these at
  132. your own risk, and please do not file bug reports about them. If you want
  133. the latest updates on game compatibility, visit our web site and view the
  134. compatibility chart.
  135.  
  136.      Maniac Mansion (Original)                     [Game: maniac]
  137.      Zak McKracken (Original)                      [Game: zak]
  138.      Putt-Putt Goes To The Moon                    [Game: puttmoon]
  139.      Putt-Putt's Fun Pack                          [Game: funpack]
  140.      Fatty Bear's Birthday Surprise                [Game: fbear]
  141.      Fatty Bear's Fun Pack                         [Game: fbpack]
  142.  
  143. The following games are SCUMM engine, but NOT supported by ScummVM (yet).
  144.  
  145.      Putt-Putt Joins the Parade
  146.      Most other Humongous Entertainment titles
  147.  
  148. Please be aware that the engine may contain bugs and unimplemented features
  149. that sometimes make it impossible to finish the game. Save often, and please
  150. file a bug report (instructions on submitting bug reports are below) if you
  151. encounter such a bug in a 'supported' game.
  152.  
  153. 3.1) Copy Protection:
  154. ---- ----------------
  155. The ScummVM team does not condone piracy. However, there are cases when
  156. LucasArts themselves bundled cracked interpreters with their own games --
  157. the data files still contain the copy protection scripts, but the interpreter
  158. bypasses them. There is no way for us to tell the difference between legitimate
  159. and pirated data files, so for the games where we know the original interpreter
  160. may have been cracked ScummVM will always have to bypass the copy protection.
  161.  
  162. At the time of writing, that includes the following games:
  163.  
  164. Indiana Jones & the Last Crusade (EGA)
  165. Indiana Jones & the Last Crusade (256 color FM Towns version)
  166. Loom (16 color floppy version)
  167. Maniac Mansion
  168. Monkey Island 1 (EGA version)
  169. Monkey Island 1 (VGA version)
  170. Monkey Island 2
  171. Zak McKracken (256 color FM Towns version)
  172.  
  173. Beneath a Steel Sky (bypassed with permission from Revolution)
  174.  
  175. In most cases ScummVM will still show the copy protection screen. Try entering
  176. any answer. Chances are that it will work.
  177.  
  178. 3.2) Simon the Sorcerer 1 and 2 notes:
  179. ---- ---------------------------------
  180. The Simon the Sorcerer 1 & 2 games were split into several targets to make
  181. coding easier and to make it more clear which target should be used:
  182.        simon1dos    - Use for Simon the Sorcerer 1 for DOS (Disk)
  183.        simon2dos    - Use for Simon the Sorcerer 2 for DOS (Disk)
  184.        simon1talkie - Use for Simon the Sorcerer 1 Talkie for DOS (CD)
  185.        simon2talkie - Use for Simon the Sorcerer 2 Talkie for DOS (CD)
  186.        simon1win    - Use for Simon the Sorcerer 1 Talkie for Windows (CD)
  187.        simon2win    - Use for Simon the Sorcerer 2 Talkie for Windows (CD)
  188.        simon2mac    - Use for Simon the Sorcerer 2 Talkie for Amiga or Mac (CD)
  189.  
  190. If you have the dual version of Simon the Sorcerer 1 or 2 on CD,
  191. then you will find the Windows version in the main directory of CD
  192. and the DOS Talkie version in the DOS directory of the CD.
  193.  
  194. 3.3) Known Problems in ScummVM 0.5.1:
  195. ---- --------------------------------
  196. This release has the following known problems. There is no need to report them,
  197. although patches to fix them are welcome. If you discover a bug that is not
  198. listed here, nor in the compatibility table on the web site, please see
  199. the section on Reporting Bugs.
  200.  
  201.        Beneath a Steel Sky:
  202.                 - Floppy demo does not work at all
  203.                 - Amiga versions aren't supported and probably never will be
  204.                 - Not a bug: CD version is missing speech for some dialog
  205.                 - ScummVM 0.5.0 contained a bug in the savegame system.
  206.                   If you experience problems using an old savegame, it may be
  207.                   corrupt, and you will need to start a new game using this
  208.                   version.
  209.  
  210.        Indiana Jones & the Last Crusade (EGA):
  211.                 - In some rooms Indy may be able to walk to odd places
  212.                 - There are some minor graphical glitches
  213.  
  214.        Indiana Jones & the Last Crusade (256):
  215.                 - No sound effects
  216.                 - In some rooms Indy may be able to walk to odd places
  217.                 - There are some minor graphical glitches
  218.  
  219.        Monkey Island (EGA & VGA versions):
  220.                 - No sound effects
  221.  
  222.        Indiana Jones and the Fate of Atlantis:
  223.                 - Keyboard fighting does not work. ScummVM now defaults to
  224.                   using mouse fighting.
  225.  
  226.        Sam and Max:
  227.                 - Highway subgame does not behave correctly.
  228.                 - Music is broken under Dreamcast, causing game freezes
  229.  
  230.        Simon the Sorcerer 1:
  231.                 - No inventory scrolling arrows shown in simon1dos and
  232.                   simon1talkie, can still move around inventory though.
  233.                 - simon1dos freezes briefly after Swampling leaves his house and
  234.                   when talking to demons in Sordid's Tower
  235.  
  236.        Simon the Sorcerer 2:
  237.                 - Text in copy protection screen of simon2dos is only shown for
  238.                   a short time
  239.                 - simon2dos and simon2talkie (With subtitles enabled) freeze 
  240.                   briefly when Pirate Captain is talking to Mate, when Simon
  241.                   tries to escape
  242.                 - Only default language in data files is supported in simon2mac
  243.                 - F10 key animation in simon2mac is different compared to
  244.                   original game
  245.  
  246.        Curse of Monkey Island
  247.                 - The "Pirate Song" scene does not play correctly
  248.                 - Some minor graphical glitches remain
  249.  
  250.        Zak McKracken (Enhanced)
  251.                 - Pushing the feet on the Mars sarcophagus may not open the
  252.                   hidden door. A workaround is to use 'Push' on the floor just
  253.                   before the feet.
  254.  
  255.        FM Towns versions:
  256.                 - No support for Kanji versions
  257.                 - All the FM Towns versions of games are extremely rare,
  258.                   And as the ScummVM team does not encourage piracy in any
  259.                   way, we don't know where to buy or download a copy of these
  260.                   games. Petition LucasArts to re-release them :)
  261.  
  262.        All CD games:
  263.                - If you are experiencing random crashes, and your game
  264.                  plays music from CD, you have encountered a Windows bug.
  265.                  Try copying the data files from CD to your hard disk, and
  266.                  running them from there.
  267.  
  268.  
  269. 4.0) Supported Platforms:
  270. ---- --------------------
  271. ScummVM has been ported to run on many platforms and operating systems.
  272. Links to these ports can be found either on the ScummVM web page or by a
  273. Google search. Many thanks to the effort of porters. If you have a port of
  274. ScummVM and wish to commit it into the main CVS, feel free to contact us!
  275.  
  276.         Windows         - SDL
  277.         Windows CE      - SDL           (iPaq and other handheld devices)
  278.         Linux           - X11 & OSS audio (includes iPaqs running Linux)
  279.         Mac OS X        - SDL
  280.         AmigaOS         - SDL/AGA
  281.         MorphOS         - Custom backend
  282.         BeOS            - SDL
  283.         Acorn (RiscOS)  - ???
  284.         Dreamcast       - Custom backend 
  285.         GP32            - Custom backend
  286.         PalmOS          - Custom backend
  287.         UNIX            - SDL           (Linux, Solaris, IRIX, *BSD)
  288.  
  289. The Dreamcast port does not support Curse of Monkey Island, nor The Dig.
  290. The PalmOS port does not support Curse of Monkey Island, Beneath a Steel
  291. Sky, nor either Simon the Sorcerer 1 or 2. The Dig will only work on some
  292. Palm devices (those with a large dynamic heap). Sam and Max is currently
  293. broken under Dreamcast, but this should be fixed in a patch soon after
  294. 0.5.1
  295.  
  296. 5.0) Running ScummVM:
  297. ---- ----------------
  298. Before you run the engine, you need to put the game's datafiles in a
  299. directory. The filenames must not be in mixed case on *nix systems
  300. (for example, these are valid names: "monkey2.000", "MONKEY2.000", while
  301. this is a bad one: "Monkey2.000"). If you use a game with speech, the file
  302. monster.sou must reside in the same directory as the datafiles.
  303.  
  304. ScummVM can be launched directly by running the executable. In this case,
  305. the in-built launcher will activate. From this, you can add games (click
  306. 'Add Game'), or launch games which have already been configured.
  307.  
  308. ScummVM can also be launched into a game directly using Command Line
  309. arguments - see the next section.
  310.  
  311. 5,1) Command Line Options:
  312. ---- ---------------------
  313.         scummvm [OPTIONS] [GAME]
  314.  
  315.         [GAME]         - Short name of game to load. For example, 'monkey' for
  316.                          Monkey Island. This can be either a known gameid, or
  317.                          a pre-configured target.
  318.  
  319.         -p<path>       - Path to where the game is installed. Default is CWD.
  320.         -x[<num>]      - Save game slot to load (default: autosave)
  321.         -f             - Full-screen mode.
  322.         -g<mode>       - Select graphics scaler. See below.
  323.         -e<mode>       - Select sound engine. See below.
  324.         -a             - Enable Amiga pal conversion, for playing Amiga
  325.                          versions
  326.         -q<lang>       - Select language. See below.
  327.         -c<num>        - Drive to play CD audio from.  E.g., 0 is first drive.
  328.         -m<num>        - Set the music volume, 0-255.  Default is '192'
  329.         -o<num>        - Set the master volume, 0-255. Default is '192'
  330.         -s<num>        - Set the sfx volume, 0-255.    Default is '192'
  331.         -t<num>        - Set music tempo. 50-200. Default is '100' (percent)
  332.         -n             - Disable subtitles. Use with games that have voice.
  333.         -y             - Set talk speed ('yak option'). Default is '60'
  334.         -l<file>       - Load alternate configuration file
  335.         -w[<file>]     - Write configuration file
  336.         -v             - Show version information and exit
  337.         -z             - Display list of games
  338.         -b<num>        - Start in room <num>.
  339.         -d[<num>]      - Set debug verbosity to <num>
  340.         -u             - Dump scripts if a directory called 'dumps' exists in
  341.                          current directory
  342.         --multi-midi   - Enable combination Adlib and native MIDI
  343.         --native-mt32  - True Roland MT-32 (disable GM emulation)
  344.         --aspect-ratio - Enable aspect ratio correction
  345.         --floppy-intro - Use floppy version intro for Beneath a Steel Sky CD
  346.  
  347. The meaning of long options can be inverted by prefixing them with "no-", e.g.
  348. --no-aspect-ratio. This is useful if you want to override a setting in the
  349. configuration file.
  350.  
  351. The short game name ('game target') you see at the end of the command
  352. line is very important. A short list is contained at the top of this
  353. file. You can also get the current list of games and game names at:
  354.         http://www.scummvm.org/compatibility.php
  355.  
  356. Examples:
  357.  * Win32:
  358.   Running Monkey Island, fullscreen, from a hard disk:
  359.    C:\Games\LucasArts\scummvm.exe -f -pC:\Games\LucasArts\monkey\ monkey
  360.   Running Full Throttle from CD, fullscreen and with subtitles disabled:
  361.    C:\Games\LucasArts\scummvm.exe -f -n -pD:\resource\ ft
  362.  
  363.  * Unix:
  364.   Running Monkey Island, fullscreen, from a hard disk:
  365.    /path/to/scummvm -f -p/games/LucasArts/monkey/ monkey
  366.   Running Full Throttle from CD, fullscreen and with subtitles disabled:
  367.    /path/to/scummvm -f -n -p/cdrom/resource/ ft
  368.  
  369. 5.1) Language options:
  370. ---- -----------------
  371. ScummVM includes a language option for Maniac Mansion, Zak McKracken, The Dig,
  372. Curse of Monkey Island, Beneath a Steel Sky. and Simon the Sorcerer 1 & 2.
  373.  
  374. Maniac Mansion and Zak McKracken
  375.         en  - English (default)
  376.         de  - German
  377.         fr  - French
  378.         it  - Italian
  379.         es  - Spanish
  380.  
  381. The Dig
  382.         jp  - Japanese
  383.         zh  - Chinese
  384.         kr  - Korean
  385.  
  386. Curse of Monkey Island
  387.         en  - English (default)
  388.         de  - German
  389.         fr  - French
  390.         it  - Italian
  391.         pt  - Portuguese
  392.         es  - Spanish
  393.         jp  - Japanese
  394.         zh  - Chinese
  395.         kr  - Korean
  396.  
  397. Beneath a Steel Sky:
  398.         gb  - English (Great Britain) (default)
  399.     en  - English USA
  400.         de  - German
  401.         fr  - French
  402.         it  - Italian
  403.         pt  - Portuguese
  404.         es  - Spanish
  405.         se  - Swedish
  406.  
  407. Simon the Sorcerer: 1 & 2
  408.         en  - English (default)
  409.         de  - German
  410.         fr  - French
  411.         it  - Italian
  412.         es  - Spanish
  413.         hb  - Hebrew
  414.  
  415. 5.3) Graphics filters:
  416. ---- -----------------
  417. ScummVM offers several anti-aliasing filters to attempt to improve visual
  418. quality. These are the same filters used in many other emulators, such as
  419. MAME. 
  420. Note: the resolutions listed assume the game was originally 320x200
  421.  
  422. They are:
  423.         normal     - No filtering, original 320x200 resolution. Fastest.
  424.         2x         - No filtering, double screen/window size to 640x400 
  425.                      (default)
  426.         3x         - No filtering, triple screen/window size to 960x600
  427.         2xsai      - 2xsai filtering, double screen/window size to 640x400
  428.         super2xsai - Enhanced 2xsai filtering. 640x400 screen/window size
  429.         supereagle - Less blurry than 2xsai, but slower. Also 640x400
  430.         advmame2x  - 640x400 scaling. Doesn't rely on blurring like 2xSAI.
  431.         advmame3x  - 960x600 scaling. Doesn't rely on blurring like 2xSAI.
  432.         tv2x       - 640x400 scaling. Horizontal scanlines.
  433.         dotmatrix  - 640x400 scaling. Dot matrix effect.
  434.         opengl     - OpenGL with bilinear filtering [Unsupported]
  435.  
  436. To select a graphics filter, pass its name via the '-g' option to scummvm,
  437. for example:
  438.  
  439.     scummvm -g advmame2x monkey2
  440.  
  441. Note #1: Not all backends support all or any filters. The ones listed above
  442. are for the default SDL backend.
  443.  
  444. Note #2: Filters can be very slow when ScummVM is compiled in a debug
  445. configuration without optimizations. And there is always a speed impact when
  446. using any form of anti-aliasing/linear filtering.
  447.  
  448. Note #3: The Fm Towns version of Zak (zak256 target) uses an original resolution
  449. of 320x240 - hence for this game scalers will scale to 640x480 or 960x720.
  450.  
  451. Note #4: The OpenGL filter is included as a curiosity only. It's use is
  452. unsupported, and unrecommended. The only benefit is hardware accelerated
  453. scaling, but any machine with an OpenGL card should be fast enough to use
  454. the software scalers (see above).
  455.  
  456. 5.4 Hot Keys:
  457. --- ---------
  458. ScummVM supports various in game hotkeys. They differ between the SCUMM and
  459. simon games.
  460.  
  461.     Common:
  462.         Ctrl-z OR Alt-x        - Quit
  463.         Keyboard Arrow Keys    - Simulate mouse movement
  464.         Ctrl-f                 - Runs in fast mode.
  465.         Ctrl-Alt 0-9           - Switch between graphics filters
  466.         Ctrl-Alt b             - Switch between bilinear and non-linear
  467.                                  filtering [OpenGL backend]
  468.         Ctrl-Alt a             - Toggle aspect-ratio correction on/off.
  469.                                  Most of the games use a 320x200 pixel
  470.                                  resolution, which may look squashed on
  471.                                  modern monitors. Aspect-ratio correction
  472.                                  stretches the image to use 320x240 pixels
  473.                                  instead, or a multiple thereof.
  474.  
  475.     SCUMM:
  476.         Ctrl 0-9 and Alt 0-9   - Load and save game state
  477.         Ctrl-g                 - Runs in really REALLY fast mode.
  478.         Ctrl-d                 - Starts the debugger.
  479.         Tilde (~)              - Show/hide the debugging console
  480.         Ctrl-s                 - Shows memory consumption.
  481.         [ and ]                - Music volume, down/up
  482.         - and +                - Text speed, slower/faster
  483.         F5                     - Displays a save/load box.
  484.         Space                  - Pauses
  485.         Period (.)             - Skips current line of text in some games
  486.         Alt-Enter              - Toggles full screen/windowed
  487.         Enter                  - Simulate left mouse button press
  488.         Tab                    - Simulate right mouse button press
  489.  
  490.     Simon:
  491.         F1 - F3                - Text speed, faster - slower
  492.         F10                    - Shows all characters and objects you can 
  493.                                  interact with (Simon the Sorcerer 2 only)
  494.         - and +                - Music volume, down/up
  495.         m                      - Music on/off
  496.         s                      - Sound effects on/off
  497.         b                      - Background sounds on/off
  498.  
  499. Note that using ctrl-f and ctrl-g are not recommended: games can crash when
  500. being ran faster than their normal speed, as scripts will lose synchronisation
  501.  
  502. 5.5 Using data files from Macintosh game versions:
  503. --- ----------------------------------------------
  504. All LucasArts SCUMM based adventures except CMI also exist in versions for the
  505. Macintosh. ScummVM can use most (all?) of them, however, in some case some
  506. additional work is required. First off, if you are not using a Macintosh for
  507. this, accessing the CD/floppy data might be tricky. There are various tools on
  508. the net for this, though.
  509.  
  510. Secondly, most of the newer games shipped only with a  single data file on the
  511. Macintosh. You first have to run the 'rescumm' tool from the scummvm-tools
  512. package to extract the data files ScummVM expects. You invoke rescumm like
  513. this (where DATAFILE is the path to the single big data file):
  514.  
  515.    rescumm DATAFILE
  516.  
  517. It will extract the data into the current directory, so make sure to run it from
  518. a writable directory.
  519.  
  520. 6.0) Savegames:
  521. ---- ----------
  522. Savegames are by default put in the current directory. You can specify the save
  523. in the config file by setting the savepath parameter. See the example config
  524. file later in this readme.
  525.  
  526. You can also use the environment variable SCUMMVM_SAVEPATH to specify where to
  527. put save games. Don't forget the trailing directory separator. Also be aware
  528. that saved games may break between ScummVM releases.
  529.  
  530. Bash (Unix) example:
  531.         export SCUMMVM_SAVEPATH=/tmp/scummvm_savegames/
  532.  
  533. Windows example:
  534.         set SCUMMVM_SAVEPATH=C:\saved_games\
  535.  
  536. 6.1) Autosaves:
  537. ---- ----------
  538. Because ScummVM is still a beta product, it -can- crash and/or hang
  539. occasionally. As such, every five minutes it will save a game in Slot 0. This
  540. game can be loaded via Ctrl-0, or the F5 menu. This autosaving does not, 
  541. however, occur with Simon the Sorcerer.
  542.  
  543.  
  544. 7.0) Music and Sound: 
  545. ---- ----------------
  546. By default, on most operating systems, ScummVM will automatically use Adlib
  547. emulation. MIDI may not be available on all operating systems or may need
  548. manual configuration. If you ARE using MIDI, you have several different
  549. choices of output, depending on your operating system and configuration.
  550.         
  551.         adlib     - Uses internal Adlib Emulation (default) 
  552.         windows   - Windows MIDI. Uses built-in sequencer, for Windows users
  553.         seq       - Uses /dev/sequencer for MIDI, *nix users. See below.
  554.         qt        - Quicktime sound, for Macintosh users.
  555.         core      - CoreAudio sound, for MacOS X users.
  556.         amidi     - Uses the MorphOS MIDI system, for MorphOS users
  557.         alsa      - Output using ALSA sequencer device. See below.
  558.         null      - Null output. Don't play any music.
  559.  
  560. To select a sound driver, pass its name via the '-e' option to scummvm,
  561. for example:
  562.  
  563.     scummvm -e adlib monkey2
  564.  
  565.  
  566. 7.1) Playing sound with Adlib emulation:
  567. ---- -----------------------------------
  568. By default an Adlib card will be emulated and ScummVM will output the music
  569. as sampled waves. This is the default mode for most games, and offers the
  570. best compatibility between machines and games.
  571.  
  572.  
  573. 7.2) Playing sound with MIDI emulation:
  574. ---- ----------------------------------
  575. Some games (such as Sam and Max) only contain MIDI music data.  This once
  576. prevented music for these games from working on platforms that do not support
  577. MIDI, or soundcards that do not provide MIDI drivers (e.g, many soundcards will
  578. not play MIDI under Linux). ScummVM can now emulate MIDI mode using sampled
  579. waves and Adlib emulation using the -eadlib option.  However, if you are capable
  580. of using native MIDI, we recommend using one of the MIDI modes below for best
  581. sound.
  582.  
  583. 7.3) Playing sound with Native MIDI:
  584. ---- -------------------------------
  585. Use the appropriate -e<mode> command line option from the list above to
  586. select your preferred MIDI device. For example, if you wish to use the
  587. Windows MIDI driver, use the -ewindows option.
  588.  
  589.  
  590. 7.4.0 Playing sound with Sequencer MIDI:                        [UNIX ONLY]
  591. ----- ----------------------------------
  592. If your soundcard driver supports a sequencer, you may set the environment
  593. variable "SCUMMVM_MIDI" to your sequencer device - e.g., /dev/sequencer
  594.  
  595. If you have problems with not hearing audio in this configuration, it is
  596. possible you will need to set the "SCUMMVM_MIDIPORT" variable to 1 or 2. This
  597. selects the port on the selected sequencer to use. Then start scummvm with the
  598. -eseq parameter. This should work on several cards, and may offer better
  599. performance and quality than Adlib emulation. However, for those systems where
  600. sequencer support does not work, you can always fall back on Adlib emulation.
  601.  
  602.  
  603. 7.4.1 Playing sound with ALSA sequencer:                        [UNIX ONLY]
  604. ----- ----------------------------------
  605. If you have installed the ALSA driver with the sequencer support, then
  606. set the environment variable "SCUMMVM_PORT" to your sequencer port - e.g. 65:0
  607.  
  608. Here is a little howto on how to use the ALSA sequencer with your soundcard.
  609. In all cases, to have a list of all the sequencer ports you have, try the
  610. command "aconnect -o -l". This should give output similar to:
  611. client 64: 'External MIDI 0' [type=kernel]
  612.     0 'MIDI 0-0        '
  613. client 65: 'Emu10k1 WaveTable' [type=kernel]
  614.     0 'Emu10k1 Port 0  '
  615.     1 'Emu10k1 Port 1  '
  616.     2 'Emu10k1 Port 2  '
  617.     3 'Emu10k1 Port 3  '
  618. client 128: 'Client-128' [type=user]
  619.     0 'TiMidity port 0 '
  620.     1 'TiMidity port 1 '
  621.  
  622. This means the external MIDI output of the sound card is located on the
  623. port 64:0, four WaveTable MIDI outputs in 65:0, 65:1, 65:2
  624. and 65:3, and two TiMidity ports, located at 128:0 and 128:1.
  625.  
  626. If you have a FM-chip on your card, like the SB16, then you have to load
  627. the soundfonts using the sbiload software. Example:
  628.   sbiload -p 65:0 /etc/std.o3 /etc/drums.o3
  629.  
  630. If you have a WaveTable capable sound card, you have to load a sbk or sf2
  631. soundfont using the sfxload software. Example:
  632.   sfxload /path/to/8mbgmsfx.sf2
  633.  
  634. If you don't have a MIDI capable soundcard, or if you want to take advantage of
  635. your TiMidity samples, then you can ask TiMidity to become an ALSA sequencer
  636. output. Here is a quick way to do so:
  637.   timidity -iAqqq -B2,8 -Os1S -s 44100 &
  638. If you get distorted output with this setting try dropping the -B2,8 or
  639. changing the value.
  640.  
  641. Then the TiMidity port will be visible from the 'aconnect -o -l' list. You
  642. should launch it as root, since it will try to set up some real time
  643. priority.
  644.  
  645. 7.5.0) Using MP3 files for CD audio:
  646. ------ -----------------------------
  647. Use LAME or some other mp3 encoder to rip the cd audio tracks to files. Name
  648. the files track1.mp3 track2.mp3 etc. ScummVM must be compiled with MAD support
  649. to use this option. You'll need to rip the file from the CD as a WAV file,
  650. then encode the MP3 files in constant bit rate sampled at 22 kHz. This can
  651. be done with the following LAME command line:
  652.  
  653.   lame -t -q 0 -b 96 --resample 22.05 track1.wav track1.mp3
  654.  
  655.  
  656. 7.5.1) Using Ogg Vorbis files for CD audio:
  657. ------ ------------------------------------
  658. Use oggenc or some other vorbis encoder to encode the audio tracks to files.
  659. Name the files track1.ogg track2.ogg etc. ScummVM must be compiled with vorbis
  660. support to use this option. You'll need to rip the files from the CD as a WAV
  661. file, then encode the vorbis files to be sampled at 22 kHz. This can be done
  662. with the following oggenc command line with the value after q specifying 
  663. the desired quality from 0 to 10:
  664.  
  665.   oggenc -q 5 --resample 22050 track1.wav
  666.  
  667.  
  668. 7.5.2) Compressing MONSTER.SOU with MP3:
  669. ------ ---------------------------------
  670. You need LAME, and our extract util from the scummvm-tools package to perform
  671. this task, and ScummVM must be compiled with MAD support.
  672.  
  673. Make a backup file of your MONSTER.SOU before attempting this. Copy your
  674. MONSTER.SOU file to a temporary folder. Then run:
  675.  
  676.   extract monster.sou
  677.  
  678. In about 30 minutes or so, you will have a much smaller monster.so3 file,
  679. copy this file to your game directory. You can safely remove the monster.sou
  680. file.
  681.  
  682.  
  683. 7.5.3) Compressing MONSTER.SOU with Ogg Vorbis:
  684. ------ ----------------------------------------
  685. As above but run:
  686.  
  687.   extract --vorbis monster.sou
  688.  
  689. This should produce a smaller monster.sog file, which you should copy to your
  690. game directory.
  691.  
  692.  
  693. 7.5.4) Compressing sfx/speech in Simon the Sorcerer 1 and 2
  694. ------ ----------------------------------------------------
  695. You need LAME, and our simon2mp3 util from the scummvm-tools package to perform
  696. this task, and ScummVM must be compiled with MAD support.
  697.  
  698. Make a backup of the file before attempting this. Copy the file to a
  699. temporary folder. Then run:
  700.  
  701.   simon2mp3 effects.voc (For simon1talkie)
  702.   simon2mp3 simon.voc   (For simon1talkie)
  703.   simon2mp3 simon.wav   (For simon1win)
  704.   simon2mp3 simon2.voc  (For simon2talkie)
  705.   simon2mp3 simon2.wav  (For simon2win) 
  706.  
  707.  
  708. In about 30 minutes or so, you will have a much smaller *.mp3 file, copy this
  709. file to your game dir. You can safely remove the old file.
  710.  
  711.  
  712. 8.0) Configuration file:
  713. ---- -------------------
  714. By default, the configuration file is saved in, and loaded from:
  715.  
  716.         Windows:  <windir>\scummvm.ini,
  717.         Unix:     ~/.scummvmrc
  718.         Mac OS X: ~/Library/Preferences/ScummVM Preferences
  719.         Others:   scummvm.ini in the current directory
  720.  
  721. An example config file looks as follows:
  722.  
  723.         [scummvm]
  724.         gfx_mode=supereagle
  725.         fullscreen=true
  726.         savepath=C:\saves\
  727.  
  728.         [germandott]
  729.         gameid=tentacle
  730.         path=C:\german\tentacle\
  731.         description=German version of DOTT
  732.  
  733.         [tentacle]
  734.         path=C:\tentacle\
  735.         nosubtitles=true
  736.         master_volume=98
  737.         music_volume=40
  738.         sfx_volume=255
  739.  
  740.         [loomcd]
  741.         cdrom=1
  742.         path=C:\loom\
  743.         talkspeed=55
  744.         
  745.         [monkey2]
  746.         path=C:\amiga_mi2\
  747.         music_driver=windows
  748.         amiga=true
  749.  
  750. The following keywords are recognized:
  751.  
  752.         amiga           bool     Tells ScummVM whether or not a game is the
  753.                                  Amiga version
  754.         basename        string
  755.         path            string   The path to where a game's data files are
  756.         read_only       bool     If true, ScummVM will never try to overwrite
  757.                                  the configuration file.
  758.         save_slot
  759.         savepath                 The path to where a game will store its
  760.                                  savegames.
  761.         versioninfo     string   The version of the ScummVM that created the
  762.                                  configuration file.
  763.  
  764.         gameid          string   The real id of a game. Useful if you have
  765.                                  several versions of the same game, and want
  766.                                  different aliases for them. See the example.
  767.         description     string   The description of the game as it will appear
  768.                                  in the launcher.
  769.  
  770.         language        string   Specify language (en, de, fr, it, pt, es, jp,
  771.                                  zh, kr,se, gb, hb)
  772.         nosubtitles     bool     Set to true to suppress subtitles.
  773.         talkspeed       number   Text speed (default: 60)
  774.  
  775.         fullscreen      bool     Fullscreen mode
  776.         aspect_ratio    bool     Enable aspect ratio correction
  777.         gfx_mode        string   Graphics mode (normal, 2x, 3x, 2xsai,
  778.                                  super2xsai, supereagle, advmame2x, advmame3x,
  779.                                  tv2x, dotmatrix)
  780.  
  781.         cdrom           int      Number of CD-ROM unit to use for audio. If
  782.                                  negative, don't even try to access the CD-ROM.
  783.         master_volume   int      The master volume setting (0-255)
  784.         music_driver    string   The music engine to use.
  785.         music_volume    int      The music volume setting (0-255)
  786.         multi_midi      bool     If true, enable combination Adlib and native
  787.                                  MIDI.
  788.         native_mt32     bool     If true, disable GM emulation and assume that
  789.                                  there is a true Roland MT-32 available.
  790.         sfx_volume      int      The sfx volume setting (0-255)
  791.         tempo           int      The music tempo (50-200) (default: 100)
  792.  
  793.         floppy_intro    bool     Use floppy version of introduction in Beneath
  794.                                  a Steel Sky (CD version)
  795.  
  796.         debuglevel      int      Enable debug output. The higher number, the
  797.                                  more verbose output.
  798.  
  799. 9.0 Compiling:
  800. --- ----------
  801. You need SDL-1.2.2 or newer (older versions may work, but are unsupported), and
  802. a supported compiler. Several compilers, including GCC, mingw and Microsoft
  803. Visual C++ are supported. If you wish to use MP3-compressed CD tracks or
  804. .SOU files, you will need to install the MAD library and define
  805. USE_MAD. Tools for compressing .SOU files to .SO3 files can be
  806. found in the 'tools' CVS module, or in the 'scummvm-tools' package.
  807.  
  808. You can also comment/uncomment appropriate lines in the build.rules file to
  809. use sdl_gl.cpp instead of sdl.cpp. This allows hardware accelerated bilinear
  810. filtering by using OpenGL textures.
  811.  
  812. On Win9x/NT/XP you can define USE_WINDBG and attach WinDbg to browse debug 
  813. messages (see http://www.sysinternals.com/ntw2k/freeware/debugview.shtml).
  814.  
  815.     GCC:
  816.         * Type make (or gmake if that's what GNU make is called on your
  817.           system) and hopefully ScummVM will compile for you.
  818.  
  819.     Mingw:
  820.         * Open Makefile.mingw, alter SDL paths and choose compiling options.
  821.         * Type make -f Makefile.mingw,  hopefully ScummVM will compile for you.
  822.  
  823.     Microsoft Visual C++:
  824.         * Open the workspace, scummwm.dsw
  825.         * Enter the path to the SDL include files in Tools|Options|Directories
  826.         * Now it should compile successfully.
  827.  
  828.     PocketPC - Windows CE:
  829.         * Download the SDLAudio library:
  830.           http://arisme.free.fr/PocketScumm/sources/SDLAudio-1.2.3-src.zip
  831.         * Open and compile the SDLAudio WCEBuild/WCEBuild workspace in EVC++
  832.         * Open the ScummVM wince/PocketScumm workspace
  833.         * Enter the SDLAudio directory to your includes path
  834.         * Enter the compiled SDLAudio.lib to your link libraries list
  835.         * Now it should compile successfully
  836.  
  837.     Debian GNU/Linux:
  838.         * Install the packages 'build-essential', 'fakeroot', 'debhelper',
  839.           'libsdl1.2-dev', and 'libmad0-dev' on your system.
  840.         * Optional: Install the 'libvorbis-dev' and/or the 'libasound2-dev'
  841.           packages, and edit the Makefile to turn on support for Ogg Vorbis
  842.           and/or the ALSA sequencer.
  843.         * Run 'make deb'.
  844.         * Finally run 'dpkg -i ../scummvm-cvs*deb', and you're done.
  845.         
  846.     Mac OS X:
  847.         * Make sure you have the developer tools installed.
  848.         * Edit backends/sdl/build.rules, and enable the Mac OS X specific 
  849.           line(s).
  850.         * Depending on where you have installed SDL, you have to add the
  851.           location of its headers to the INCLUDES variables. For example if you
  852.           installed SDL via Fink, you can add this at the end of build.rules:
  853.           INCLUDES+= -I/sw/include
  854.         * You can now 'make' to create a command line binary.
  855.         * To get a version you can run from Finder, type 'make bundle' which
  856.           will create ScummVM.app.
  857.  
  858. X.X Credits:
  859. --- --------
  860.  The ScummVM team:
  861.         James Brown          - Lead developer
  862.         Max Horn             - Lead developer
  863.         Robert Goeffringmann - Engine: Beneath a Steel Sky (maintainer)
  864.         Jonathan Gray        - Engine: SCUMM
  865.         Oliver Kiehl         - Engine: Beneath a Steel Sky, Simon
  866.         Pawel Kolodziejski   - Engine: SCUMM (Codecs, iMUSE, Smush, etc.)
  867.         Joost Peters         - Engine: Beneath a Steel Sky
  868.         Chris Apers          - Port: PalmOS
  869.         Nicolas Bacca        - Port: PocketPC/WinCE port
  870.         Marcus Comstedt      - Port: Dreamcast
  871.         Ruediger Hanke       - Port: MorphOS
  872.         Travis Howell        - Port: Win32, Engine: Simon (maintainer)
  873.         Peter Moraliyski     - Port: GP32
  874.         Lionel Ulmer         - Port: X11
  875.         Torbjorn Andersson   - Generic bugfixer and patch submitter
  876.         Jamieson Christian   - iMUSE, MIDI, all things musical.
  877.         Jochen Hoenicke      - Speaker & PCjr sound support, Adlib work
  878.         Jeremy Newman        - Webmaster
  879.  
  880.  Retired Team Members:
  881.         Ralph Brorsen        - Help with GUI implementation
  882.         Vincent Hamm         - Co-Founder
  883.         Felix Jakschitsch    - Zak256 reverse engineering
  884.         Mutwin Kraus         - Original MacOS porter
  885.         Ludvig Strigeus      - Original ScummVM and SimonVM author
  886.  
  887.  Contributors:
  888.         Stuart Caie          - Decoders for Simon 1 Amiga data files
  889.         Janne Huttunen       - V3 actor mask support, Dig/FT Smush audio
  890.         Kovacs Endre Janos   - Several fixes for Simon1
  891.         Jeroen Janssen       - Numerous readability and bugfix patches
  892.         Claudio Matsuoka     - Daily Linux/BeOS builds 
  893.         Gregory Montoir      - AdvanceMAME Scale-2X, TV 2x and dot matrix
  894.                                implementation
  895.         Mikesch Nepomuk      - MI1 VGA floppy patches.
  896.         Nicolas Noble        - Config file and ALSA support
  897.         Edward Rudd          - Fixes for playing MP3 versions of MI1/Loom audio
  898.         Daniel Schepler      - Final MI1 CD music support/ 
  899.                                Initial Ogg Vorbis support
  900.         Andre Souza          - SDL-based OpenGL renderer
  901.         Tim 'realmz'         - Initial MI1 CD music support
  902.  
  903.         And to all the contributors, users, and beta testers we've missed.
  904.         Thanks!
  905.  
  906.  Special thanks to:
  907.         Sander Buskens  - For his work on the initial reversing of Monkey2
  908.         Kevin Carnes    - For Scumm16, the basis of ScummVM older gfx codec
  909.         Jim Leiterman   - Various info on his Fm Towns/Marty SCUMM ports
  910.         Jimmi Thogersen - For ScummRev, and much obscure code/documentation
  911.  
  912.         Tony Warriner and everyone at Revolution Software Ltd. for sharing
  913.         with us the source of some of their brilliant games, allowing us to
  914.         release Beneath a Steel Sky as freeware... and generally being
  915.         supportive above and beyond the call of duty.
  916.  
  917.         Aric Wilmunder, Ron Gilbert, David Fox, Vince Lee, and all those at
  918.         LucasFilm/LucasArts who made SCUMM the insane mess to reimplement
  919.         that it is today. Feel free to drop us a line and tell us what you
  920.         think, guys!
  921.  
  922.  
  923.  
  924. ------------------------------------------------------------------------
  925. Good Luck and Happy Adventuring!
  926. The ScummVM team.
  927. http://www.scummvm.org/
  928. ------------------------------------------------------------------------
  929.